STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

H.?? StructureDefinition: hspc-Height

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/hspc-height

The HSPC specific profile for the observation of one's height or body length.

This profile was published on Mon, May 18, 2015 00:00+1000 as a draft by HSPC.

H.??.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Observation.

Summary

Mandatory: 1 element
Fixed Value: 2 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... hspc-extensionsdataOriginationMode 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdataOriginationMode
Binding: HSPC Data Origination Mode (preferred)
... hspc-extensionsdeltaFlag 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeltaFlag
Binding: Abnormal Interpretation Numeric Nom (required)
... hspc-extensionsassociatedPrecondition 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsassociatedPrecondition
Binding: HSPC Height Meas Associated Precondition (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierUnique Id for this particular observation
... status ?! ∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code ∑1..1CodeableConceptType of observation (code / type)
Binding: LOINC Codes (example)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"8302-2","display":"Body height"}]}
... subject ∑0..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... encounter 0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... performer ∑0..*Reference(HSPC ProviderPractitioner | HSPCOrganization | HSPC-Patient | RelatedPerson)Who is responsible for the observation
... valueQuantity ∑1..1QuantityActual result
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value ∑0..1decimalNumerical value (with implicit precision)
.... comparator ?! ∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit ∑0..1stringUnit representation
.... system ∑ I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code ∑0..1codeCoded form of the unit
Binding: HSPC Height Units of Measure Value Set (preferred)
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about result
... method 0..1CodeableConceptHow it was done
Binding: HSPC Height Meas Method Device (preferred)
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... meaning 0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... related ∑0..*BackboneElementResource related to this observation
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... type 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
.... target 1..1Reference(Observation | QuestionnaireResponse)Resource that is related to this one
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

todo

This structure is derived from Observation.

Summary

Mandatory: 1 element
Fixed Value: 2 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I0..*ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... hspc-extensionsdataOriginationMode 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdataOriginationMode
Binding: HSPC Data Origination Mode (preferred)
... hspc-extensionsdeltaFlag 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeltaFlag
Binding: Abnormal Interpretation Numeric Nom (required)
... hspc-extensionsassociatedPrecondition 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/hspc-extensionsassociatedPrecondition
Binding: HSPC Height Meas Associated Precondition (preferred)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierUnique Id for this particular observation
... status ?! ∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code ∑1..1CodeableConceptType of observation (code / type)
Binding: LOINC Codes (example)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"8302-2","display":"Body height"}]}
... subject ∑0..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... encounter 0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... performer ∑0..*Reference(HSPC ProviderPractitioner | HSPCOrganization | HSPC-Patient | RelatedPerson)Who is responsible for the observation
... valueQuantity ∑1..1QuantityActual result
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value ∑0..1decimalNumerical value (with implicit precision)
.... comparator ?! ∑0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit ∑0..1stringUnit representation
.... system ∑ I0..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code ∑0..1codeCoded form of the unit
Binding: HSPC Height Units of Measure Value Set (preferred)
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
... comment 0..1stringComments about result
... method 0..1CodeableConceptHow it was done
Binding: HSPC Height Meas Method Device (preferred)
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange I0..*BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... low I0..1SimpleQuantityLow Range, if relevant
.... high I0..1SimpleQuantityHigh Range, if relevant
.... meaning 0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: Observation Reference Range Meaning Codes (example)
.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... related ∑0..*BackboneElementResource related to this observation
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... type 0..1codehas-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
Binding: ObservationRelationshipType (required)
.... target 1..1Reference(Observation | QuestionnaireResponse)Resource that is related to this one
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... referenceRange 0..*Unknown reference to #referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

H.??.2 Terminology Bindings

PathNameConformanceValueSet
Observation.language?extrequiredhttp://tools.ietf.org/html/bcp47
Observation.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionsdataOriginationMode]]		HSPC Data Origination ModepreferredHSPC Data Origination Mode
Observation.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionsdeltaFlag]]		Abnormal Interpretation Numeric NomrequiredAbnormal Interpretation Numeric Nom
Observation.extension
[UriType[http://hl7.org/fhir/StructureDefinition/hspc-extensionsassociatedPrecondition]]		HSPC Height Meas Associated PreconditionpreferredHSPC Height Meas Associated Precondition
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodesexampleObservation Category Codes
Observation.codeLOINC CodesexampleLOINC Codes
Observation.valueQuantity.comparatorQuantityComparatorrequiredQuantityComparator
Observation.valueQuantity.codeHSPC Height Units of Measure Value SetpreferredHSPC Height Units of Measure Value Set
Observation.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
Observation.methodHSPC Height Meas Method DevicepreferredHSPC Height Meas Method Device
Observation.referenceRange.meaningObservation Reference Range Meaning CodesexampleObservation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason

H.??.3 Constraints

IdPathDetailsRequirements
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
obs-7ObservationComponent code SHALL not be same as observation code
XPath: not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0
obs-3Observation.referenceRangeMust have at least a low or a high or text
XPath: (exists(f:low) or exists(f:high)or exists(f:text))
.